Crate ockam_node
source ·Expand description
This crate provides an implementation of an Ockam [Ockam][main-ockam-crate-link] Node and is intended for use by crates that provide features and add-ons to the main [Ockam][main-ockam-crate-link] library.
The main [Ockam][main-ockam-crate-link] crate re-exports types defined in
this crate, when the "std"
feature is enabled.
Re-exports
Modules
- Api helpers
- Callback utility
- MPSC channel type aliases
- Async Mutex and RwLock
- Debugger
- Support for storing persistent values
Structs
- Context contains Node state and references to the runtime.
- Allow to send message to destination address periodically after some delay Only one scheduled heartbeat allowed at a time Dropping this handle cancels scheduled heartbeat
- Underlying Ockam node executor
- Full set of options to
send_and_receive_extended
function - Full set of options to
send_and_receive_extended
function - Start a node with a custom setup configuration
- A minimal worker implementation that does nothing
- Start a
Processor
- Start a
Worker
with a custom configuration
Enums
- Enumeration of error causes in ockam_node
- Messages sent from the Node to the Executor
- Reasons why a generic Ockam Node operation has failed
- Reasons why adding an external router has failed
- Successful return values from a router command
- Specify the type of node shutdown
- Reasons why a worker operation has failed
Constants
- A default timeout in seconds
Traits
- This trait can be used to integrate transports into a node
Type Aliases
- A special sender type that connects a type to an AsyncDrop handler
- A special type of
Context
that has no worker relay and inherits the parentContext
’s access control - The reply/result of a Node